@gtagle Can you please review the following for accuracy/any feedback and approve if it looks good? 🙏🏻

Updated workflows docs

These got an edit to make sure the wording matched the newer UI and updated screenshots where relevant. Not that significant of a change, but just in case:

Working with model workflows

Mostly updated the screenshots:

LIVE PREVIEW

Customize model lifecycle statuses

Very minor adjustment:

LIVE PREVIEW

Set up model workflows

Edited some of the instructions to line up with the new UI text, and redid some examples/screenshots:

LIVE PREVIEW

PR Summary

This pull request introduces several enhancements to the release scripts and workflow documentation:

1. Release Scripts Enhancements:

   • In generate-release-notes.ipynb, the script now provides additional guidance on creating release folders and files, and it automatically opens the newly created release-notes.qmd file.
   • In generate_release_objects.py, a subprocess is added to open the release notes file in VS Code, with error handling for potential exceptions.
   • In year-end-cleanup.ipynb, similar enhancements are made to open the newly created yearly release file automatically.
   • In yearly_cleanup.py, subprocess functionality is added to open the yearly release file in VS Code, with error handling.

2. Workflow Documentation Updates:

   • Updates to _configure-workflow-steps.qmd and _link-workflow-steps.qmd include clarifications on step configurations and linking steps, with improved instructions and animations.
   • _model-workflows-see.qmd and working-with-model-workflows.qmd are updated to include callouts for hover animations and improved visual aids.
   • customize-model-lifecycle-statuses.qmd and set-up-model-workflows.qmd have been updated for clarity in instructions and terminology, such as changing "Add Model Lifecycle Status modal" and "User Roles".

These changes aim to improve user experience by providing clearer instructions and automating certain tasks in the release process.

Test Suggestions

• Test the creation of release folders and files to ensure they are correctly named and opened in VS Code.
• Verify that the error handling works when VS Code is not available or the subprocess fails.
• Check the updated workflow documentation for clarity and accuracy in the instructions.
• Ensure that the animations and images in the documentation are correctly displayed and relevant.
• Test the subprocess functionality in different environments to ensure compatibility.

PR Summary

This pull request introduces several enhancements to the release scripts and workflow documentation:

1. Release Scripts Enhancements:

   • In generate-release-notes.ipynb, the script now provides additional guidance by opening the newly created release-notes.qmd file automatically after creation.
   • In generate_release_objects.py, a new feature has been added to open the release notes file in VS Code after creation. This is done using a subprocess.run call, with error handling to catch and print any exceptions that occur during the process.
   • In year-end-cleanup.ipynb, similar functionality is added to open the newly created yearly release file automatically.
   • In yearly_cleanup.py, the script now attempts to open the copied template file in VS Code, with error handling for any exceptions.

2. Workflow Documentation Updates:

   • Updates to the workflow configuration guides to improve clarity and user experience.
   • Changes in the instructions for adding and configuring workflow steps, including the use of double-click to open configuration modals and updated button labels.
   • Enhanced visual aids with updated screenshots and GIFs to better illustrate the workflow processes.
   • Added callouts to highlight interactive elements, such as hover animations for workflow steps.
   • Adjustments to the terminology used in the documentation to align with current UI elements, such as changing "User group" to "User Roles".

3. Miscellaneous:

   • Minor text adjustments and formatting improvements across various documentation files to enhance readability and consistency.

Test Suggestions

• Test the creation of release notes to ensure the file opens automatically in VS Code without errors.
• Verify that the error handling for opening files in VS Code works correctly by simulating a failure scenario.
• Check the updated workflow documentation for accuracy and clarity, ensuring all steps are correctly described.
• Test the new workflow step configuration process to ensure the double-click functionality works as intended.
• Review the updated visual aids in the documentation to confirm they accurately represent the current UI.
• Ensure that all references to 'User group' have been updated to 'User Roles' in the documentation.

A PR preview is available: Preview URL